DM-46496: Include advanced query system objects in docs #1099
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhirving
commented
Oct 16, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1099 +/- ##
==========================================
- Coverage 89.74% 89.74% -0.01%
==========================================
Files 361 361
Lines 47410 47409 -1
Branches 5724 5724
==========================================
- Hits 42549 42548 -1
Misses 3508 3508
Partials 1353 1353 ☔ View full report in Codecov by Sentry. |
`Butler.query` has been public for a while, but the documentation for the `Query` object it returns was not included in the documentation. This change pulls in the user-facing portions of the interface without any of the internal objects. (The internal objects are sometimes referenced from constructors, but those constructors are documented as "do not use".)
dhirving
force-pushed
the
tickets/DM-46496
branch
from
02917b4
to
f27bf9f
Compare
timj
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Butler.queryhas been public for a while, but the documentation for theQueryobject it returns was not included in the documentation.This change pulls in the user-facing portions of the interface without any of the internal objects. (The internal objects are sometimes referenced from constructors, but those constructors are documented as "do not use".)
Checklist
doc/changesconfigs/old_dimensions